List Profiles

Route

/v2/streaming/profiles

Description

Retrieve a list of all streaming profiles configured in your organization. Profiles define what data to stream and how to stream it.

Method

GET

Inputs

Parameter	Type	Required	Description
None	-	-	No parameters required

Output

Field	Type	Description
resources	array[Profile]	Array of profile objects
errors	array[Error]	Any errors encountered

Profile Object Structure

Field	Type	Description
id	string	Unique profile identifier
name	string	Human-readable name
description	string	Detailed description
sources	array[Source]	Data sources to stream
destination_id	string	Target destination ID
count_threshold	integer	Batch size threshold
delay_threshold	string	Batch delay threshold
state	string	Profile state (active, stopped, paused)
dead_letter_state	string	Dead letter queue state
scope_id	string	Scope identifier
config	object	Profile configuration

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "resources": [
    {
      "id": "profile-123",
      "name": "Security Events Stream",
      "description": "Stream security incidents to SIEM",
      "sources": [
        {
          "type": "incidents"
        }
      ],
      "destination_id": "dest-456",
      "count_threshold": 1000,
      "delay_threshold": "10s",
      "state": "active",
      "dead_letter_state": "ready",
      "scope_id": "scope-789",
      "config": {
        "include_ai_summary": true
      }
    }
  ],
  "errors": []
}